Il posizionamento dei marcatori di testo all'interno delle stringhe è di cattivo stile? C'è un'alternativa?

Lavoro con stringhe enormi che richiedono molta manipolazione.

Ad esempio, potrei generare una stringa come questa:

Parte 1
Barca

Sezione A
Programmazione

Parte 2
Partizionare le barche per la programmazione.

Sezione AA
Sezione Voci SQL.

La stringa sarebbe troppo grande per controllare manualmente ogni sua parte. Ora ho bisogno di splitquesto stringin a stringlistsezioni e parti. Mi vengono in mente due opzioni:

Un'espressione regolare:

QStringList sl = s.split(QRegularExpression("\n(?=Part [0-9]+|Section [A-Z]+)"));

Sembra che dovrebbe funzionare, ma a volte le eccezioni sfuggono (IE: Section SQL Entriesverrebbero erroneamente divise)

Altrimenti ciò che potrei fare è posizionare un marcatore quando generi la stringa iniziale:

🚤💻Parte 1
barca

🚤💻 Sezione A
Programmazione

🚤💻Parte 2
Partizionare le barche per la programmazione.

🚤💻
Sezione Sezione AA Voci SQL.

Ciò significa che dividere la stringa diventerebbe facile:

QStringList sl = s.split("🚤💻"));

Qualcosa mi dice però che nessuno di questi sono buoni stili o pratiche di programmazione, ma fino a questo punto non ne ho discusso né trovato un'alternativa.

• Se tu fossi il mio project manager, accetteresti uno di questi metodi?
• In caso contrario, cosa suggeriresti di fare come best practice?

Non è una cattiva pratica avere la codifica di documenti incorporata come testo in una stringa. Pensa a markdown, HTML, XML, JSON, YAML, LaTeX, ecc.

Ciò che è cattiva pratica è reinventare la ruota. Invece di scrivere il tuo elaboratore di testi, pensa a utilizzare uno standard esistente. Esistono molti software gratuiti che eseguono gran parte dell'analisi per te e molti hanno una licenza non restrittiva che ti consente di utilizzare tale software nel tuo software proprietario.

L'uso di un separatore comune dovrebbe funzionare bene quando si suddividono stringhe arbitrarie più grandi, ma sconsiglio di utilizzare un simbolo arbitrario. Qualcuno che legge quella stringa come testo in chiaro potrebbe essere confuso, per non parlare dei problemi con UTF e se il simbolo appare o meno all'interno delle sezioni o meno.

La parte più importante di questo è che ogni sezione rimane intatta, mentre ogni "intestazione di sezione" deve essere opportunamente identificata.

Perché non usare un separatore comune ma tenerlo leggibile? Qualcosa di simile a:

[SECTION]
Part 1
Boat

[SECTION]
Section A
Programming

[SECTION]
Part 2
Partitioning boats for programming.

[SECTION]
Section AA
Section SQL Entries.

Il problema è decidere quale dovrebbe essere il separatore , in quanto deve essere garantito che non venga visualizzata alcuna sezione. È possibile identificarlo ulteriormente come separatore richiedendo che sia all'inizio di una riga e l' unico testo su quella riga .

Senza un'ulteriore conoscenza del testo previsto in ogni sezione, è difficile formulare una raccomandazione su quale separatore comune sarebbe meglio in questo caso.

La risposta accettata sembra aver perso quello che hai scritto in un commento:

Il motivo è che molta della manipolazione che faccio richiede l'intera stringa

e ha dato questo come esempio:

s.replace ("barca", "programmazione");

Se è quello che vuoi, è davvero una cattiva idea usare IMHO come "markdown" o separatore testuale per tutta la tua stringa, questo ha sempre un certo rischio di interferire con la manipolazione e non porterà a un codice robusto. Soprattutto quando si tenta di iniziare a utilizzare espressioni regolari su una stringa così combinata, probabilmente si incontreranno gli stessi problemi osservati dalle persone quando si tenta di analizzare HTLM o XML con espressioni regolari .

Soprattutto perché hai scritto che potrebbero esserci "migliaia di [tali manipolazioni] funzioni", che il rischio potrebbe diventare un vero problema. Anche se usi un markdown come XML per memorizzare l'elenco di stringhe internamente, devi assicurarti che la manipolazione elaborerà solo il contenuto, non il markdown, quindi ciò significherebbe dividere la stringa in parti prima di eseguire qualsiasi elaborazione e unire in seguito di nuovo - quindi questo avrà un alto rischio di darti una cattiva prestazione.

La migliore alternativa di progettazione qui è quella di fornire un tipo di dati astratto (utilizzare una classe se lo si desidera), chiamarlo MyStringListe fornire un piccolo insieme di operazioni di base che consentono di implementare le "migliaia di funzioni" in termini di tali operazioni. Ad esempio, ci potrebbe essere generico finde replaceoperazioni, o un generico funzionale mapoperazione . Puoi anche aggiungere qualcosa come JoinToStringun'operazione se hai davvero bisogno dell'intero elenco in una stringa per determinati scopi.

Usando queste operazioni, la tua paura che il codice diventi più complicato perché "tutto dovrebbe essere fatto in un ciclo for" diventa inutile, perché gli unici forloop che ottieni sono incapsulati all'interno delle operazioni del tipo di dati. E non sarei preoccupato per le prestazioni fino a quando non avrai un impatto reale e misurabile sulle prestazioni (che dubito che otterrai se eseguirai correttamente le operazioni di base).

Il formato descritto è molto simile ai file INI:

https://en.wikipedia.org/wiki/INI_file

In tal caso la sezione è racchiusa tra parentesi quadre [], quindi ciò che descrivi ha senso contrassegnando la sezione in qualche modo per aggiungere ulteriore significato a quel testo.

Ad esempio, potrei generare una stringa come questa:

Domanda: Da cosa "generi" questa stringa?

Sarebbe che essere più facile da manipolare?